+2002-01-08 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather
+ than XIDs in the docs.
+
+ * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs.
+
Tue Jan 8 18:39:23 2002 Jonathan Blandford <jrb@redhat.com>
* gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow!
+2002-01-08 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather
+ than XIDs in the docs.
+
+ * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs.
+
Tue Jan 8 18:39:23 2002 Jonathan Blandford <jrb@redhat.com>
* gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow!
+2002-01-08 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather
+ than XIDs in the docs.
+
+ * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs.
+
Tue Jan 8 18:39:23 2002 Jonathan Blandford <jrb@redhat.com>
* gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow!
+2002-01-08 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather
+ than XIDs in the docs.
+
+ * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs.
+
Tue Jan 8 18:39:23 2002 Jonathan Blandford <jrb@redhat.com>
* gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow!
+2002-01-08 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather
+ than XIDs in the docs.
+
+ * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs.
+
Tue Jan 8 18:39:23 2002 Jonathan Blandford <jrb@redhat.com>
* gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow!
+2002-01-08 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather
+ than XIDs in the docs.
+
+ * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs.
+
Tue Jan 8 18:39:23 2002 Jonathan Blandford <jrb@redhat.com>
* gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow!
+2002-01-08 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkplug.c, gtk/gtksocket.c: Speak of window IDs rather
+ than XIDs in the docs.
+
+ * gtk/gtkclipboard.c (gtk_clipboard_clear): Fix docs.
+
Tue Jan 8 18:39:23 2002 Jonathan Blandford <jrb@redhat.com>
* gtk/gtktreedatalist.c (gtk_tree_data_list_compare_func): wow!
+2002-01-08 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/tmpl/gtksocket.sgml, gtk/tmpl/gtkplug.sgml: speak of
+ window IDs rather than XIDs.
+
2002-01-07 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtksocket.sgml: Mention gtk_socket_get_id()
to embed widgets from one process into another process
in a fashion that is transparent to the user. One
process creates a #GtkSocket widget and, passes the
-XID of that widgets window to the other process,
-which then creates a #GtkPlug window with that XID.
+ID of that widgets window to the other process,
+which then creates a #GtkPlug with that window ID.
Any widgets contained in the #GtkPlug then will appear
inside the first applications window.
</para>
<!-- ##### FUNCTION gtk_plug_construct ##### -->
<para>
-Finish the creation of a #GtkPlug widget. This function
+Finishes the creation of a #GtkPlug widget. This function
will generally only be used by classes deriving
from #GtkPlug.
</para>
@plug: a #GtkPlug widget.
-@socket_id: the XID of the socket's window.
+@socket_id: the window ID of the socket.
<!-- ##### FUNCTION gtk_plug_new ##### -->
<para>
-Create a new plug widget inside the #GtkSocket identified
-by @socket_id.
+Creates a new plug widget inside the #GtkSocket identified
+by @socket_id. If @socket_id is 0, the plug is left "unplugged" and
+can later be plugged into a #GtkSocket by gtk_socket_add_id().
</para>
-@socket_id: the XID of the socket's window.
+@socket_id: the window ID of the socket, or 0.
@Returns: the new #GtkPlug widget.
to embed widgets from one process into another process
in a fashion that is transparent to the user. One
process creates a #GtkSocket widget and, passes the
-XID of that widget's window to the other process,
-which then creates a #GtkPlug window with that XID.
+that widget's window ID to the other process,
+which then creates a #GtkPlug with that window ID.
Any widgets contained in the #GtkPlug then will appear
inside the first applications window.
</para>
<para>
-The XID of the socket's window is obtained by using
+The socket's window ID is obtained by using
gtk_socket_get_id(). Before using this function,
the socket must have been realized, and for hence,
have been added to its parent.
<example>
-<title>Obtaining the XID of a socket.</title>
+<title>Obtaining the window ID of a socket.</title>
<programlisting>
GtkWidget *socket = gtk_socket_new (<!>);
gtk_widget_show (socket);
* the ancestors of the socket is not yet visible.
*/
gtk_widget_realize (socket);
-g_print ("The XID of the sockets window is %#x\n",
+g_print ("The ID of the sockets window is %#x\n",
gtk_socket_get_id (socket));
</programlisting>
</example>
</para>
<para>
-Note that if you pass the XID of the socket to another
+Note that if you pass the window ID of the socket to another
process that will create a plug in the socket, you
must make sure that the socket widget is not destroyed
until that plug is created. Violating this rule will
<!-- ##### STRUCT GtkSocket ##### -->
<para>
-The #GtkSocket structure contains the following field.
-(This field should be considered read-only. It should
+The #GtkSocket structure contains the <structfield>plug_window</structfield>
+field. (This field should be considered read-only. It should
never be set by an application.)
</para>
-@plug_window:
-the window embedded inside this #GtkSocket.
+@plug_window: the window embedded inside this #GtkSocket.
<!-- ##### FUNCTION gtk_socket_new ##### -->
* @clipboard: a #GtkClipboard
*
* Clears the contents of the clipboard. Generally this should only
- * be called between the time you call gtk_clipboard_set_contents(),
+ * be called between the time you call gtk_clipboard_set_with_owner()
+ * or gtk_clipboard_set_with_data(),
* and when the @clear_func you supplied is called. Otherwise, the
* clipboard may be owned by someone else.
**/
* @plug: a #GtkPlug
* @socket: a #GtkSocket
*
- * Add a plug to a socket within the same application.
+ * Adds a plug to a socket within the same application.
**/
void
_gtk_plug_add_to_socket (GtkPlug *plug,
* @plug: a #GtkPlug
* @socket: a #GtkSocket
*
- * Remove a plug from a socket within the same application.
+ * Removes a plug from a socket within the same application.
**/
void
_gtk_plug_remove_from_socket (GtkPlug *plug,
/**
* gtk_socket_steal:
* @socket: a #GtkSocket
- * @wid: the XID of an existing toplevel window.
+ * @wid: the window ID of an existing toplevel window.
*
* Reparents a pre-existing toplevel window into a #GtkSocket. This is
* meant to embed clients that do not know about embedding into a
/**
* gtk_socket_add_id:
* @socket: a #GtkSocket
- * @window_id: the XID of a client participating in the XEMBED protocol.
+ * @window_id: the window ID of a client participating in the XEMBED protocol.
*
* Adds an XEMBED client, such as a #GtkPlug, to the #GtkSocket. The
* client may be in the same process or in a different process.
*
* To embed a #GtkPlug in a #GtkSocket, you can either create the
- * #GtkPlug with gtk_plug_new (0), call gtk_plug_get_id() to get the
- * window ID of the plug, and then pass that to the
+ * #GtkPlug with <literal>gtk_plug_new (0)</literal>, call
+ * gtk_plug_get_id() to get the window ID of the plug, and then pass that to the
* gtk_socket_add_id(), or you can call gtk_socket_get_id() to get the
* window ID for the socket, and call gtk_plug_new() passing in that
* ID.
*
* Gets the window ID of a #GtkSocket widget, which can then
* be used to create a client embedded inside the socket, for
- * instance with gtk_plug_new ().
+ * instance with gtk_plug_new().
*
* The #GtkSocket must have already be added into a toplevel window
* before you can make this call.
projects / gtk4.git / commitdiff